home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / EDITORS / WEBKIT3 / !HTML / !Help < prev    next >
Text File  |  1996-08-30  |  13KB  |  249 lines
  1. Name     : !HTML²
  2. Purpose  : A macro insertion tool to make HTML even easier!
  3. Author   : Richard Goodwin
  4. Status   : Freeware
  5. Version  : 2.01 (August 1996)
  6. Features : User definable macros for all common HTML commands split over four
  7.            windows - Styles, Effects, Characters and Addresses
  8.  
  9. This application, along with the files contained within, © Richard Goodwin
  10. 1996.  This application may be freely distributed by any means AS LONG AS:
  11.  
  12. * all files remain intact, with the possible except of the macro definition
  13.   and option files but...
  14. * wherever possible the default definition and option files should be the ones
  15.   used in distribution copies
  16. * no unreasonable charge is made.
  17.  
  18. Quick User Guide:
  19. ~~~~~~~~~~~~~~~~~
  20. Load it.  Click on iconbar icon.  Window opens.  Click on icon, stuff appears
  21. in text windows with input focus.  'Nuff said.
  22.  
  23. Preamble:
  24. ~~~~~~~~~
  25. Anyone can create World Wide Web pages on the Acorn range of computers; all you
  26. need is a text editor, such as !Edit, and preferably a web browser to test your
  27. pages.
  28.  
  29. However, the most annoying thing about doing it this way is the repetition of
  30. having to type in common commands over and over again.  I tried using normal
  31. macro insertion tools, but they just didn't quite work how I wanted - too slow,
  32. couldn't see enough buttons, forever having to define or load definitions etc.
  33. So, I wrote one myself!
  34.  
  35. In fact I wrote more than one, and users of the original can drop their
  36. original definition files on to a running copy of this latest version and hey
  37. presto - their original definition files can be used (and even saved as the
  38. default!)
  39.  
  40. Starting Up:
  41. ~~~~~~~~~~~~
  42. Pretty simple really.  Double-click on the !HTML² icon to load it, and four
  43. small icons appear on the icon bar; these are "S", "E", "Ç" and "A", which
  44. stand for "Styles", "Effects", "Characters" and "Addresses" (and NOT a certain
  45. well-known games console company :).  Clicking with the LEFT mouse button opens
  46. the window for that set of macros; clicking with the RIGHT mouse button will
  47. load the macro definitions for that set of macros into your text editor.  Of
  48. course the MIDDLE mouse button will open a menu, and this is the same whichever
  49. icon you're over at the time.  Note that due to the size of the icons you do
  50. have to be fairly accurate with your mouse pointer; to make the icons any
  51. bigger would take up a large amount of icon bar!
  52.  
  53. The menu and the choices window are explained later in this file.
  54.  
  55. Editing Macros:
  56. ~~~~~~~~~~~~~~~
  57. Looking at the definition files you can see that everything is pretty self
  58. explanitary; altering the text after "HEAD=" will define the macro for
  59. the Header macro; it can be any length up to 255 characters, with
  60. any characters apart from a carriage return (which the program takes to be the
  61. end of the definition) and a backslash - "\".  (The backslash is used to tell
  62. the program to insert a carriage return when typing the macro, so
  63. line1\line2\line2
  64. will come out as
  65. line1
  66. line2
  67. line3
  68. in case you really must have that carriage return!)
  69.  
  70. Obviously with 255 characters to play with this means that where you define,
  71. say, what <H1> will look like, you can actually have lots of effects added to
  72. it; if you want all headlines to be centered, bright green and have a line
  73. straight through them you can, just by putting these in the H1ON definition!
  74. Just make sure when you define NOH1 to switch them all back off again though...
  75.  
  76. The only special cases to macro definitions are the colours for the colour
  77. palette; you can ONLY have a set of six characters after the "=" sign, and
  78. these characters are the hexadecimal numbers to define the red, green and blue
  79. parts of the colour in the standard RRGGBB format.  If you don't understand
  80. this way of defining colours... well, I've put quite a nice selection on there,
  81. perhaps you ought to leave them like that... ;-)
  82.  
  83. As well as defining macros, in some cases you can even change the writing that
  84. appears in the icon for that macro!  For instance, you can change the icon that
  85. says "Address03" to read "My email address".  You control this by altering any
  86. macro definitions that end in "TAG", such as "AdTag03" - defs are for defining
  87. the actual macro, and tag is for defining the icon.  These will be restricted
  88. to a certain length depending on the icon.
  89. Here's an example:
  90. AdTag03=My email address
  91. AdDef03=<a href="mailto:mabel@argonet.co.uk">Richard Goodwin</a>
  92. The icon will say "My email address", and when it's clicked on you'll get the
  93. "<a href...." stuff inserted into your text editor.
  94.  
  95. Safety First
  96. ~~~~~~~~~~~~
  97. If any of the definitions files are accidentally deleted, there's no need to
  98. worry.  Firstly, !HTML² won't crash if it doesn't find the file - it just
  99. defines its own macros and uses them.  These are almost identical to the
  100. example definition files supplied.  Secondly, if you do lose a definition file
  101. you can click on "Save definitions as default" to generate new ones.  Or if
  102. you've /just/ lost a file, look in "!HTML².Backups" - there might be a backup
  103. file (it does this when you click on "Save definitions..." just in case).
  104.  
  105. A lot of work has gone into making sure you don't crash the program with bad
  106. definitions: definitions /don't/ have to be in the same order, the names
  107. /don't/ have to be in capital or lower case letters, and /don't/ have to be all
  108. there - !HTML² checks the file for any macro or tag definitions, and if it
  109. finds any it converts the variable part at the front to capitals automatically
  110. then matches them up with the correct program variables.  All you have to do is
  111. make sure there's an "=" right after the definition with gaps, 'cos if there
  112. isn't it will be ignored.  Finally the numbers in the definitions (i.e. the
  113. "03" in "AdTag03") don't have to have that leading zero, it's just there so
  114. that everything lines up nicely.  You can even have completely blank lines in
  115. your definition files, they'll just be ignored.
  116.  
  117. Other safety features: you can click on a second macro button while a macro is
  118. already being typed it won't interupt the first; !HTML² will simply wait until
  119. the first is finished, then start typing the next one.  You can chain together
  120. quite a few commands like this if you're fast enough!  However, if you try too
  121. many (i.e. if adding another macro to the chain would exceed the maximum
  122. permitted length) then !HTML² will just beep at you and do the ones it can.
  123.  
  124. Special Features
  125. ~~~~~~~~~~~~~~~~
  126. You can also have lots of macro files - if you drop a text file
  127. onto the iconbar icon or any macro window it will be parsed to see if any
  128. macros can be found, so you can have a whole set sitting on your hard drive...
  129. Note that these are cumulative, i.e. loading a new definitions file only
  130. overwrites the macros and icons which are defined in that file and leaves all
  131. the other macros alone, so if you just create a file with "AdDef01" defined and
  132. drop this onto !HTML², every other definition will be unaffected.  If you drop a
  133. set of macros onto the icon and think, "Hmm, wouldn't it be nice to have those
  134. as the default ones," then just click on the "Save definitions.." option in the
  135. Choices window and the program will make it so - or you can get the program to
  136. do this for you every time you quit.
  137.  
  138. This means that users of !HTMacroL can drop their User file on !HTML² and can
  139. use almost all of their definitions; if you look inside "!HTML².Examples" you'll
  140. find an old User file, plus three files containing just palette information -
  141. ColorsAcrn has the Acorn 16 colour desktop palette, ColorsGrey has 32 shades of
  142. grey, and ColorsNorm has the default full-colour palette.
  143.  
  144. But the fun doesn't end there - dropping other types of file onto !HTML² also
  145. does groovy stuff!  JPEG and GIF files will cause !HTML² to insert the code
  146. necessary to display that image!  HTML files will add links to that file!
  147. Archives and Sparkives will be linked to!  By combining macro buttons and
  148. this drag-and-drop stuff you hardly need to type at all now...
  149.  
  150. The Menu:
  151. ~~~~~~~~~
  152.  ___________
  153. |__HTML__2__|
  154. |Info      >|  - pretty obvious really
  155. |-----------|
  156. |Styles     |  - opens "Styles" window
  157. |Effects    |  - opens "Effects" window
  158. |Characters |  - opens "Characters" window
  159. |Addresses  |  - opens "Addresses" window
  160. |-----------|
  161. |Choices  > |  - allows the saving of window states etc.
  162. |Reload     |  - if you alter a definition file, click this to use it instantly
  163. |-----------|
  164. |Quit_______|  - Quits the program, removes all four icons; with the right
  165.                  options selected it can also save window states and macro
  166.                  definition files.
  167.  
  168. The Options:
  169. ~~~~~~~~~~~~
  170. * Autosave window states:
  171.   If this is switched on then when you quit !HTML² it will save the position,
  172.   size and scrollbar postion of each window and whether it is open or not.
  173.   Next time you load up the windows will have these attributes, and opened if
  174.   necessary.  Note that if you change to a smaller screen mode I've made sure
  175.   the windows can't go off the side of the screen, so windows will be pushed
  176.   in to the available space.  You can use the "Don't use window states on
  177.   startup" to delete the definition file.
  178. * Autosave macro definitions:
  179.   With this ticked quitting !HTML² will cause the macro definitions to be saved
  180.   as the default ones to use.  This is handy if for instance you're forever
  181.   dropping different colour palettes on to !HTML² - the last one used will be
  182.   loaded next time.
  183.  
  184. * Save window states as default:
  185.   This saves the position, size and scrollbar postion of each window so that 
  186.   next time you load up !HTML² the windows will be in your favourite places.
  187.   See the bit about "Autosave window states:" for more info.
  188. * Reload window states:
  189.   If you've saved your favourite window states then moved the windows around, 
  190.   you can instantly set them back to your prefered places with this button.
  191. * Don't use window states on startup:
  192.   Using this option will remove the file storing the window states, and so the
  193.   !HTML² windows will remain closed and when opened will be in the postion I
  194.   defined as defaults.  If you use "Save window states as default" or quit the
  195.   program with "Autosave window states" switched on then obviously the windows
  196.   will again be opened wherever you've told them to.
  197.  
  198. * Save definitions as default:
  199.   Saves the current macro files to disc, and makes a backup of any files already
  200.   present.  If you've dropped a definition files, such as a new colour palette,
  201.   on to !HTML² then you should use this button if you want to keep these colours
  202.   as your standard ones.
  203. * Reload definitions:
  204.   If you don't like the changes you've made by dropping definitions file onto
  205.   !HTML² then use this to get the default ones back.  Also, if you've made
  206.   changes to the definition files then click on this to use them straight away.
  207. * View scripts:
  208.   This opens the directory with the definition files in it.
  209. * View backups:
  210.   This opens the directory with any backups of definition files in it; backups
  211.   are made when you "Save definitions as default" (or use the "Autosave macro
  212.   definitions" feature).
  213.  
  214. Have fun!
  215. ~~~~~~~~~
  216. I'm sure you'll come up with other uses for !HTML² - as it inserts text into
  217. text editors, word processors, email programs, even some writable icons you can
  218. build up frequently-used phrases, email addresses and so on; there's even a
  219. customised version of this program out there just for inserting IRC commands :-)
  220.  
  221. Rich, Nov. '95 - Aug. '96.
  222. Email mabel@argonet.co.uk
  223.  
  224. Versions:
  225. ~~~~~~~~~
  226. 1.00: first version
  227. 1.01: when I actually got round to using it in a real situation, realised I'd
  228.       forgotten to include <center> and </center>.  Oh well...
  229. 1.02: added polling after each character insert so that characters didn't get
  230.       lost and line feeds didn't screw up the text underneath.  Slows it down a
  231.       little, but not too much.  Tested in StrongEd, Edit and Zap.
  232. 1.03: Clicking on a button while a macro was part-way through insertion stopped
  233.       the first macro and the second took over.  Now they'll form an orderly
  234.       queue, space permitting (otherwise you'll get a beep).  Speed increased
  235.       by only polling every fifth character (or on a linespace or space).
  236. 1.04: Added </P> button and changed default centring commands to be compatible
  237.       with Netscapisms/HTML3.  Distributed via ArgoNet WebPack package.
  238. 2.00: Seperated into 4 windows (and so 4 icons - easier than I hoped!); finally
  239.       got it to do a colour palette; figured out changing writing on buttons.
  240.       Reload function added, as well as the loading definitions into a text
  241.       editor.  Dropping files on icon/windows to do file-specific macros (or
  242.       load as definitions) added.
  243. (IRC Macro version 1.00ß limited release; RichMacro, the same but with
  244.       different sprites, put to work to add different sign-offs to the end of
  245.       all technical support emails, and insert frequently-used phrases into
  246.       emails too :)
  247. 2.01: Window position saving finally added thanks to Jason Tribbeck; this file
  248.       updated and example files added.  Released via ArgoNet WebPack package.
  249.